Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Updated config docs - transform #8583

Merged
merged 7 commits into from
May 2, 2020
Merged

Updated config docs - transform #8583

merged 7 commits into from
May 2, 2020

Conversation

danm
Copy link
Contributor

@danm danm commented Jun 19, 2019

I've added a default option to clear up any confusion, hopefully that will make it more obvious how it should be added back in when additional transformers are added.

Summary

It wasn't clear to me when adding an SVG transformer that the default transformer is ignored. Especially as in the docs the default is undefined

As per #8574 it was recommended I could update the docs to make this a little clearer

Test plan

docs only.

@facebook-github-bot
Copy link
Contributor

Thank you for your pull request and welcome to our community. We require contributors to sign our Contributor License Agreement, and we don't seem to have you on file. In order for us to review and merge your code, please sign up at https://code.facebook.com/cla. If you are contributing on behalf of someone else (eg your employer), the individual CLA may not be sufficient and your employer may need the corporate CLA signed.

If you have received this in error or have any questions, please contact us at cla@fb.com. Thanks!

danm added a commit to danm/jest that referenced this pull request Jun 19, 2019
@facebook-github-bot
Copy link
Contributor

Thank you for signing our Contributor License Agreement. We can now accept your code for this (and any) Facebook open source project. Thanks!

Copy link
Contributor

@jeysal jeysal left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @danm!
@SimenB any concerns with having the default mentioned in the docs deviate from the defaults.ts (if they are the effective defaults, just handled specially)? It's not auto generated or something so...

docs/Configuration.md Outdated Show resolved Hide resolved
docs/Configuration.md Outdated Show resolved Hide resolved
Copy link
Contributor Author

@danm danm left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks! I have updated according to your suggestions. Thanks for being nice :)

@codecov-io
Copy link

Codecov Report

Merging #8583 into master will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##           master    #8583   +/-   ##
=======================================
  Coverage   63.24%   63.24%           
=======================================
  Files         272      272           
  Lines       11311    11311           
  Branches     2760     2761    +1     
=======================================
  Hits         7154     7154           
  Misses       3540     3540           
  Partials      617      617

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update be9ccf9...397a95a. Read the comment docs.

Copy link
Member

@SimenB SimenB left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is great, thanks! Could you also update the versioned docs?

@jeysal
Copy link
Contributor

jeysal commented Jun 20, 2019

@SimenB for versioned docs, below v24 would have to be ^.+\\.jsx?$, but other than that the text applies to all versions, correct?

@SimenB
Copy link
Member

SimenB commented Jul 16, 2019

@jeysal yup, the pattern changed just for 24, otherwise the docs should match 🙂

@jeysal
Copy link
Contributor

jeysal commented Aug 11, 2019

@danm mind adding the mentioned changes to website/versioned_docs to this PR?
Feel free to ask if we were unclear about anything :)

@SimenB
Copy link
Member

SimenB commented Nov 9, 2019

@danm ping

danm and others added 7 commits May 2, 2020 19:57
I've added a default option to clear up any confusion, hopefully that will make it more obvious how it should be added back in  when additional transformers are added.
Co-Authored-By: Tim Seckinger <seckinger.tim@gmail.com>
Copy link
Collaborator

@thymikee thymikee left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Rebased and updated versioned docs

@thymikee thymikee merged commit 3078172 into jestjs:master May 2, 2020
@thymikee
Copy link
Collaborator

thymikee commented May 2, 2020

Thank you @danm! Looking forward to future contributions 😊

jeysal added a commit to jeysal/jest that referenced this pull request May 2, 2020
…hile-running

* upstream/master: (331 commits)
  chore: update ts-eslint (jestjs#9953)
  Updated config docs with default transform value (jestjs#8583)
  Update jest-phabricator documentation (jestjs#8662)
  chore: remove dependency on `realpath-native` (jestjs#9952)
  chore: bump dated dependencies (jestjs#9951)
  chore: another try at fixing test-utils dependency
  chore: update lockfile due to beta release
  chore: move changelog entry and fix tets utils dependency
  Fix time duration formatting as per SI (jestjs#9765)
  v26.0.0-alpha.0
  chore: run some jsdom tests in leak check (jestjs#9938)
  chore: upgrade chalk to v4 (jestjs#9752)
  feat: upgrade to JSDOM 16 (jestjs#9606)
  chore: remove checks for compileFunction (jestjs#9949)
  chore: drop node 8 support  (jestjs#9423)
  Remove leftover `providesModuleNodeModules` (jestjs#9948)
  [BREAKING] Pojer -> Nakazawa
  chore: revert lockfile changes from 2b32fe6
  chore: move changelog entry and fix lint
  Remove `providesModuleNodeModules` from Jest. (jestjs#9583)
  ...
@github-actions
Copy link

This pull request has been automatically locked since there has not been any recent activity after it was closed. Please open a new issue for related bugs.
Please note this issue tracker is not a help forum. We recommend using StackOverflow or our discord channel for questions.

@github-actions github-actions bot locked as resolved and limited conversation to collaborators May 11, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants